docs: Expand deployment guide (CI/CD, GCP, read/write separation, cluster-sidecar)#1651
Merged
Conversation
Adds a starter CI/CD page covering the spice-cloud-deploy-action GitHub Action for Spice Cloud Platform deployments and pointers to the existing Argo CD and Flux GitOps guides for self-hosted Kubernetes. Refs #1049
✅ Pull with Spice PassedPassing checks:
|
|
🚀 deployed to https://3b5a65f4.spiceai-org-website.pages.dev |
|
🚀 deployed to https://859c8168.spiceai-org-website.pages.dev |
- Introduced a new document for GCP integrations detailing data connectors, AI models, embeddings, and authentication methods. - Updated the main deployment guide to include GCP as a deployment target and outlined deployment architectures. - Added a new guide for read/write separation to optimize data ingestion and querying workloads. - Created a cluster-sidecar architecture document to explain the benefits and considerations of this deployment model. - Updated snapshots documentation to reference the new read/write separation guide and clarified configuration options.
lukekim
changed the title
|
🚀 deployed to https://f526a2f8.spiceai-org-website.pages.dev |
|
🚀 deployed to https://0074e721.spiceai-org-website.pages.dev |
|
🚀 deployed to https://0ad81569.spiceai-org-website.pages.dev |
krinart
approved these changes
May 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refs #1049
Expanded what started as a small CI/CD section into a broader refresh of the deployment documentation. The deployment guide now leads with open-source Helm-based deployment, adds a GCP guide alongside AWS/Azure, renames the Hybrid architecture to Cluster-Sidecar (matching the blog post), and documents the production read/write separation pattern that splits ingest from reads via shared acceleration snapshots.
Changes
New deployment guides
deployment/ci-cd/index.md— Helm-first CI/CD guide. Leads withhelm upgrade --installfrom GitHub Actions and GitLab CI, covers chart/runtime version pinning and per-environment values overlays, links Argo CD/Flux GitOps as the recommended multi-cluster approach, and demotes thespicehq/spice-cloud-deploy-actionand Spice Cloud Connect Repository to one option among several.deployment/gcp/index.md+deployment/gcp/integrations.md— GCP deployment guide covering GKE (with Workload Identity, Local SSD/Hyperdisk, Gateway/LB, Managed Prometheus), Cloud Run, and Compute Engine, plus a GCP integrations page (BigQuery via ADBC, Cloud Storage via S3 connector, Cloud SQL/AlloyDB, Iceberg/Delta on GCS, Gemini models/embeddings, snapshot location withgs://, IAM role bindings).deployment/read-write-separation.md— production architecture guide for separating writes/ingest (cluster) from reads (application sidecars/agents). Includes Spicepod examples for both tiers (cluster withsnapshots: enabled, read instances withsnapshots: bootstrap_only), live query delegation via thespiceai:connector, Helm topology, capacity sizing, security model, and observability.Architecture rename
architectures/hybrid.mdtoarchitectures/cluster-sidecar.mdand the corresponding partial. Updated frontmatter, links, and references across the deployment index and architecture overview.Deployment index refresh
deployment/index.md— rewrote the intro to lead with the three real choices (binary/Docker, Kubernetes, managed). Added a goal-based "Choose a deployment target" section, a self-hosted enterprise tip pointing at the Spice.ai Enterprise Kubernetes Operator, one-line architecture descriptions, and a "when to use" table covering all guides including GCP and Read/Write Separation.Cross-references
Test plan
cd website && npm run buildpasses locally (broken-link checker green).https://spiceai.org/...URLs where required by the broken-link checker (matching the AWS / Azure pattern).website/docs/tags.yml.This page is unversioned (
website/docs/); no propagation toversioned_docs/is needed for new content.